Skip to content

DOC: Clarify rolling min_periods default value GH21489 #23021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2018

Conversation

mattboggess
Copy link
Contributor

@pep8speaks
Copy link

Hello @mattboggess! Thanks for submitting the PR.

@codecov
Copy link

codecov bot commented Oct 6, 2018

Codecov Report

Merging #23021 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #23021   +/-   ##
=======================================
  Coverage   92.19%   92.19%           
=======================================
  Files         169      169           
  Lines       50835    50835           
=======================================
  Hits        46868    46868           
  Misses       3967     3967
Flag Coverage Δ
#multiple 90.61% <ø> (ø) ⬆️
#single 42.35% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/window.py 96.4% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5551bcf...9323c00. Read the comment docs.

@gfyoung gfyoung added Docs Window rolling, ewma, expanding labels Oct 7, 2018
@@ -462,7 +462,8 @@ class Window(_Window):
min_periods : int, default None
Minimum number of observations in window required to have a value
(otherwise result is NA). For a window that is specified by an offset,
this will default to 1.
this will default to 1. Otherwise, this will default to the size of the
window.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the pronoun "this" is grammatically vague here. Can we replace "this" with "min_periods" (surrounded with backticks)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's better. This has been replaced.

Copy link
Member

@gfyoung gfyoung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

cc @datapythonista

@jreback jreback added this to the 0.24.0 milestone Oct 7, 2018
@jreback jreback merged commit c114891 into pandas-dev:master Oct 7, 2018
@jreback
Copy link
Contributor

jreback commented Oct 7, 2018

this is fine. thank you.

tm9k1 pushed a commit to tm9k1/pandas that referenced this pull request Nov 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Window rolling, ewma, expanding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pandas.rolling.apply skip calling function if window contains any NaN
4 participants